home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / utilities / misc / quotegiver102.lha / quotegiver.doc < prev    next >
Encoding:
Text File  |  1994-08-26  |  4.6 KB  |  128 lines
  1.                        QuoteGiver v1.02 by Omar Siddique
  2.                            for the Amiga computer
  3.                               August 25, 1994
  4.  
  5.  
  6. WHAT IS QUOTEGIVER AND WHAT GOOD IS IT?
  7.  
  8.    QuoteGiver is a fortune cookie program.  That is, it randomly selects a
  9. quote from a list and displays it.  There are other, similar, programs
  10. already available for the Amiga, but I think this one is a nice implementation
  11. of the idea.  I use it myself.  :-)  Besides, I needed the programming
  12. experience.
  13.  
  14.    QuoteGiver includes a sampling of my favorite quotes that I've collected
  15. over time -- 225 of them.
  16.  
  17.  
  18. HOW TO USE QUOTEGIVER
  19.  
  20.   QuoteGiver is simple to use.  Simply type:
  21.  
  22. QuoteGiver <pathname>
  23.  
  24. with the pathname being the directory where your .quoteslist is located.
  25. If no pathname is provided, QuoteGiver will check the current directory and 
  26. then the s: directory.
  27.  
  28.    It works well to include QuoteGiver in your shell-startup file.
  29.  
  30.  
  31. HOW TO ADD QUOTES TO THE LIST
  32.  
  33.    Adding quotes is simplicity itself.  Simply fire up your favorite text 
  34. editor and edit .quoteslist.  The three things to keep in mind are:
  35.  
  36. 1)  The quotation (and attribution if any) MUST be enclosed in quotation marks.
  37.     If you need to quote something inside the quotation, use single quotes.
  38.  
  39. 2)  The quotation being added MUST be preceded by a number and period.  The
  40.     number has to be one more than the previous quote.  So, if the last quote 
  41.     was number 225, the next quote should look like this:
  42.  
  43.     226. "This is my quotation"
  44.  
  45. 3)  The first line at the beginning of the .quoteslist file MUST be
  46.     NUMQUOTES=x (all caps, no spaces), with x being the actual number of quotes
  47.     in the list.  The NUMQUOTES figure should correspond to the last quote
  48.     number, if all is well.
  49.  
  50. And that's all!  QuoteGiver will then use your new quotes.  Make sure you
  51. update the NUMQUOTES figure, or QuoteGiver won't know you've added new ones.
  52.  
  53.  
  54. COMPATIBILITY, BUGS, AND LIMITATIONS
  55.  
  56.    QuoteGiver was tested on an Amiga 3000/25 with 5 megs of RAM, KS 2.04, 
  57. and Workbench 2.1.  It should run without any problems on any Amiga.
  58.  
  59.    There are no known bugs.  The only possible problem that may arise is if
  60. QuoteGiver is called twice within one second, it will produce the same quote
  61. twice.  This is the result of using the number of seconds past the minute
  62. (among other things) to generate the random seed.
  63.  
  64.    The only limitation is that a quote may not be any longer than 2000
  65. characters.  Since a quote this size would scroll off the screen on a
  66. 80 characters by 24 lines display, I'm assuming this is sufficient
  67. for most people.  If you find this to be a problem, please let me know.
  68.  
  69.  
  70. CONTACTING THE AUTHOR
  71.  
  72.    Feel free to send any comments, question, complaints, flames, bug-reports,
  73. requests, your favorite quotes, and whatever else to me at:
  74.  
  75.    Internet: osiddi1@umbc.edu
  76.              o.siddique2@genie.geis.com
  77.       GEnie: O.Siddique2
  78.  
  79. Or if you prefer to use slower means (or wish to send presents, money, 
  80. a new SGI Indy, etc):
  81.  
  82.  Snail Mail: Omar Siddique
  83.              P.O. Box 451
  84.              Perry Hall, MD  21128
  85.  
  86.  
  87. DISTRIBUTION AND DISCLAIMER
  88.  
  89.    QuoteGiver is freely distributable.  However, it must be distributed in
  90. its intact, original archive, which includes this document, the executable,
  91. and the .quoteslist file.
  92.  
  93.    While QuoteGiver has proven stable and problem free, the standard disclaimer
  94. applies; this program should work just fine, be harmless entertainment, and so
  95. forth, but if it causes your computer to achieve sentience and take over the
  96. world, or you get jailed for bombing somebody after reading the "There are few
  97. personal problems that can't be solved by a suitable application of high
  98. explosives", the author is not responsible or liable for any damage or claims
  99. that result. :-)
  100.  
  101.  
  102. OTHER FINE WORKS BY THE AUTHOR
  103.  
  104.    QuoteGiver for UNIX.
  105.  
  106.    Quoter, a utility to, at a set interval (or immediately), change the
  107.    quote in your UNIX .signature file.
  108.  
  109.  
  110. VERSION NOTES
  111.  
  112. 1.00     Initial Release
  113.  
  114. 1.01     Increased maximum quote size to 2000 chars -- this should be
  115.          more than enough for our purposes.
  116.          
  117.          Fixed a minor bug which could cause an infinite loop if the user had
  118.          for some reason deleted a number quote that was within the range
  119.          of NUMQUESTS without replacing it, and QuoteGiver tried to access
  120.          that quote.
  121.  
  122.          Minor source and documentation revisions.
  123.  
  124. 1.02     Slight improvement to random quote selector.
  125.          Fixed a potential bug if the path to .quoteslist exceeded 120 chars.
  126.          Added a slightly lengthier .quoteslist to the standard distribution
  127.          (with 20 additional quotes).
  128.